4.1.2 踢出在线用户
基本信息
Path： /api/v1/monitor/kickoutUsers
Method： POST
接口描述：
请求参数
Headers
| 参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
|---|---|---|---|---|
| Content-Type | application/json | 必须 |
Body
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| idList | string[] | 与userList二选一 | 欲踢出会话ID列表(非用户ID，而是通过查询在线用户接口返回的ID) | idList和userList只传一个即可，都传时以idList为准 | |
| userList | object[] | 与idList二选一 | 欲踢出用户信息列表 | >=2.2.10 SP3开始支持（2.2.12除外） idList和userList只传一个即可，都传时以idList为准 |
|
| ├─name | string | 必须 | 用户名 | ||
| ├─userDirectoryName | string | 必须 | 用户目录名 |
注意
- 上述请求参数body中的idList的会话id非用户id，请使用查询在线用户接口获取对应的id。
- 若使用userList通过用户名和用户目录名进行踢出用户，如果该用户同时在多个终端登录，则该用户的所有终端都会被踢下线。
请求示例
{
"userList": [
{
"name": "张三",
"userDirectoryName": "LDAP用户目录"
},
{
"name": "李四",
"userDirectoryName": "LDAP用户目录"
}
]
}
返回数据
| 名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
|---|---|---|---|---|---|
| code | string | 必须 | 返回码，0 返回成功 | ||
| data | object | 必须 | 报文数据主体 | ||
| msg | string | 必须 | 返回提示信息，与返回码对应 |
返回示例
{
"code": 0,
"data": {},
"msg": "请求成功"
}
错误信息
| 错误提示 | 错误码 |
|---|---|
| 参数检查出错 | 7201 |